<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.6"/>
<title>3dchess: GameConfiguration Struct Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
  $(document).ready(function() { searchBox.OnSelectItem(0); });
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td style="padding-left: 0.5em;">
   <div id="projectname">3dchess
   </div>
   <div id="projectbrief">Basic chess application with OpenGL graphics and AI</div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.6 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
  <div id="navrow1" class="tabs">
    <ul class="tablist">
      <li><a href="index.html"><span>Main&#160;Page</span></a></li>
      <li><a href="namespaces.html"><span>Namespaces</span></a></li>
      <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
      <li><a href="files.html"><span>Files</span></a></li>
      <li>
        <div id="MSearchBox" class="MSearchBoxInactive">
        <span class="left">
          <img id="MSearchSelect" src="search/mag_sel.png"
               onmouseover="return searchBox.OnSearchSelectShow()"
               onmouseout="return searchBox.OnSearchSelectHide()"
               alt=""/>
          <input type="text" id="MSearchField" value="Search" accesskey="S"
               onfocus="searchBox.OnSearchFieldFocus(true)" 
               onblur="searchBox.OnSearchFieldFocus(false)" 
               onkeyup="searchBox.OnSearchFieldChange(event)"/>
          </span><span class="right">
            <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
          </span>
        </div>
      </li>
    </ul>
  </div>
  <div id="navrow2" class="tabs2">
    <ul class="tablist">
      <li><a href="annotated.html"><span>Class&#160;List</span></a></li>
      <li><a href="classes.html"><span>Class&#160;Index</span></a></li>
      <li><a href="hierarchy.html"><span>Class&#160;Hierarchy</span></a></li>
      <li><a href="functions.html"><span>Class&#160;Members</span></a></li>
    </ul>
  </div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Namespaces</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark">&#160;</span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark">&#160;</span>Enumerator</a></div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

</div><!-- top -->
<div class="header">
  <div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pub-static-methods">Static Public Member Functions</a> &#124;
<a href="#pub-attribs">Public Attributes</a> &#124;
<a href="#friends">Friends</a> &#124;
<a href="struct_game_configuration-members.html">List of all members</a>  </div>
  <div class="headertitle">
<div class="title">GameConfiguration Struct Reference</div>  </div>
</div><!--header-->
<div class="contents">

<p>Class for holding game configuration parameters.  
 <a href="struct_game_configuration.html#details">More...</a></p>

<p><code>#include &lt;<a class="el" href="_game_configuration_8h_source.html">GameConfiguration.h</a>&gt;</code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:aadbba5e52fb35dddee58be6b4361fe9e"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_game_configuration.html#aadbba5e52fb35dddee58be6b4361fe9e">save</a> (const std::string &amp;path) const </td></tr>
<tr class="memdesc:aadbba5e52fb35dddee58be6b4361fe9e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Saves this configuration to the given path.  <a href="#aadbba5e52fb35dddee58be6b4361fe9e">More...</a><br/></td></tr>
<tr class="separator:aadbba5e52fb35dddee58be6b4361fe9e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab25329873b948acbe9a08eebe8f4863e"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ab25329873b948acbe9a08eebe8f4863e"></a>
bool&#160;</td><td class="memItemRight" valign="bottom"><b>operator==</b> (const <a class="el" href="struct_game_configuration.html">GameConfiguration</a> &amp;other) const </td></tr>
<tr class="separator:ab25329873b948acbe9a08eebe8f4863e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6eccee2edfe71eb940675d952a076993"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a6eccee2edfe71eb940675d952a076993"></a>
std::string&#160;</td><td class="memItemRight" valign="bottom"><b>toString</b> () const </td></tr>
<tr class="separator:a6eccee2edfe71eb940675d952a076993"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-methods"></a>
Static Public Member Functions</h2></td></tr>
<tr class="memitem:a3e8442874235664926d9bff0d329bfe8"><td class="memItemLeft" align="right" valign="top">static boost::optional<br class="typebreak"/>
&lt; <a class="el" href="struct_game_configuration.html">GameConfiguration</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_game_configuration.html#a3e8442874235664926d9bff0d329bfe8">load</a> (const std::string &amp;path)</td></tr>
<tr class="memdesc:a3e8442874235664926d9bff0d329bfe8"><td class="mdescLeft">&#160;</td><td class="mdescRight">Loads a game configuration from disk.  <a href="#a3e8442874235664926d9bff0d329bfe8">More...</a><br/></td></tr>
<tr class="separator:a3e8442874235664926d9bff0d329bfe8"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5c48c5464d3683185e8ddef45949c887"><td class="memItemLeft" align="right" valign="top">static bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_game_configuration.html#a5c48c5464d3683185e8ddef45949c887">save</a> (const <a class="el" href="struct_game_configuration.html">GameConfiguration</a> &amp;config, const std::string &amp;path)</td></tr>
<tr class="memdesc:a5c48c5464d3683185e8ddef45949c887"><td class="mdescLeft">&#160;</td><td class="mdescRight">Saves a given game configuration to a file.  <a href="#a5c48c5464d3683185e8ddef45949c887">More...</a><br/></td></tr>
<tr class="separator:a5c48c5464d3683185e8ddef45949c887"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
Public Attributes</h2></td></tr>
<tr class="memitem:acd905836d5abcd60f9414cd5be4eee5d"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="acd905836d5abcd60f9414cd5be4eee5d"></a>
int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_game_configuration.html#acd905836d5abcd60f9414cd5be4eee5d">timeBetweenTurnsInSeconds</a></td></tr>
<tr class="memdesc:acd905836d5abcd60f9414cd5be4eee5d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Minimum time between turns for display purposes. <br/></td></tr>
<tr class="separator:acd905836d5abcd60f9414cd5be4eee5d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af6449a33bf9e1e469f516f178d6239f8"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="af6449a33bf9e1e469f516f178d6239f8"></a>
int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_game_configuration.html#af6449a33bf9e1e469f516f178d6239f8">maximumTurnTimeInSeconds</a></td></tr>
<tr class="memdesc:af6449a33bf9e1e469f516f178d6239f8"><td class="mdescLeft">&#160;</td><td class="mdescRight">Maximum time between turns after which to time out a move. <br/></td></tr>
<tr class="separator:af6449a33bf9e1e469f516f178d6239f8"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="friends"></a>
Friends</h2></td></tr>
<tr class="memitem:ac98d07dd8f7b70e16ccb9a01abf56b9c"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ac98d07dd8f7b70e16ccb9a01abf56b9c"></a>
class&#160;</td><td class="memItemRight" valign="bottom"><b>boost::serialization::access</b></td></tr>
<tr class="separator:ac98d07dd8f7b70e16ccb9a01abf56b9c"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Class for holding game configuration parameters. </p>
<dl class="section note"><dt>Note</dt><dd>Can be stored and read from disc using save/load. </dd></dl>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="a3e8442874235664926d9bff0d329bfe8"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">boost::optional&lt; <a class="el" href="struct_game_configuration.html">GameConfiguration</a> &gt; GameConfiguration::load </td>
          <td>(</td>
          <td class="paramtype">const std::string &amp;&#160;</td>
          <td class="paramname"><em>path</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Loads a game configuration from disk. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">path</td><td>Path to file. </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><a class="el" href="struct_game_configuration.html" title="Class for holding game configuration parameters. ">GameConfiguration</a> on success. boost::none on failure. </dd></dl>

</div>
</div>
<a class="anchor" id="a5c48c5464d3683185e8ddef45949c887"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">bool GameConfiguration::save </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="struct_game_configuration.html">GameConfiguration</a> &amp;&#160;</td>
          <td class="paramname"><em>config</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const std::string &amp;&#160;</td>
          <td class="paramname"><em>path</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Saves a given game configuration to a file. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">config</td><td>Configuration to save. </td></tr>
    <tr><td class="paramname">path</td><td>Path to save configuration to. </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>True on success. </dd></dl>

</div>
</div>
<a class="anchor" id="aadbba5e52fb35dddee58be6b4361fe9e"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">bool GameConfiguration::save </td>
          <td>(</td>
          <td class="paramtype">const std::string &amp;&#160;</td>
          <td class="paramname"><em>path</em></td><td>)</td>
          <td> const</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Saves this configuration to the given path. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">path</td><td>Path to file to save to. </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>True on success. </dd></dl>

</div>
</div>
<hr/>The documentation for this struct was generated from the following files:<ul>
<li>S:/dev/3dchess/src/core/<a class="el" href="_game_configuration_8h_source.html">GameConfiguration.h</a></li>
<li>S:/dev/3dchess/src/core/GameConfiguration.cpp</li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Mon Jan 6 2014 02:31:48 for 3dchess by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.6
</small></address>
</body>
</html>
